From 79d10021e7cfd1e6fe3cce755a3812c59b6868a9 Mon Sep 17 00:00:00 2001 From: Behnam Esfahbod Date: Thu, 31 Aug 2017 12:53:55 -0700 Subject: [PATCH] [doc/book] Improve page titles --- src/doc/book/src/03-02-manifest.md | 3 +++ src/doc/book/src/03-05-build-scripts.md | 2 +- src/doc/book/src/03-08-source-replacement.md | 2 +- src/doc/book/src/03-10-policies.md | 2 +- src/doc/book/src/SUMMARY.md | 6 +++--- src/doc/book/src/cargo-in-depth.md | 14 +++++++------- 6 files changed, 16 insertions(+), 13 deletions(-) diff --git a/src/doc/book/src/03-02-manifest.md b/src/doc/book/src/03-02-manifest.md index a5d25e77b..2b2367ad6 100644 --- a/src/doc/book/src/03-02-manifest.md +++ b/src/doc/book/src/03-02-manifest.md @@ -1,5 +1,8 @@ ## The Manifest Format +The `Cargo.toml` file for each package is called its *manifest*. Every manifest +file consists of one or more sections. + ### The `[package]` section The first section in a `Cargo.toml` is `[package]`. diff --git a/src/doc/book/src/03-05-build-scripts.md b/src/doc/book/src/03-05-build-scripts.md index 9b7367c4c..6d775ed1b 100644 --- a/src/doc/book/src/03-05-build-scripts.md +++ b/src/doc/book/src/03-05-build-scripts.md @@ -1,4 +1,4 @@ -## Build Script Support +## Build Scripts Some packages need to compile third-party non-Rust code, for example C libraries. Other packages need to link to C libraries which can either be diff --git a/src/doc/book/src/03-08-source-replacement.md b/src/doc/book/src/03-08-source-replacement.md index dcb88346d..8407bc0e6 100644 --- a/src/doc/book/src/03-08-source-replacement.md +++ b/src/doc/book/src/03-08-source-replacement.md @@ -1,4 +1,4 @@ -## Replacing sources +## Source Replacement Cargo supports the ability to **replace one source with another** to express strategies along the lines of mirrors or vendoring dependencies. Configuration diff --git a/src/doc/book/src/03-10-policies.md b/src/doc/book/src/03-10-policies.md index f6565d305..9d48d095f 100644 --- a/src/doc/book/src/03-10-policies.md +++ b/src/doc/book/src/03-10-policies.md @@ -1,4 +1,4 @@ -## Crates.io package policies +## Crates.io Package Policies In general, these policies are guidelines. Problems are often contextual, and exceptional circumstances sometimes require exceptional measures. We plan to diff --git a/src/doc/book/src/SUMMARY.md b/src/doc/book/src/SUMMARY.md index ab4028d2f..b5b7dd306 100644 --- a/src/doc/book/src/SUMMARY.md +++ b/src/doc/book/src/SUMMARY.md @@ -18,14 +18,14 @@ * [Cargo In Depth](cargo-in-depth.md) * [Specifying Dependencies](03-01-specifying-dependencies.md) - * [Cargo.toml Format](03-02-manifest.md) + * [The Manifest Format](03-02-manifest.md) * [Configuration](03-03-config.md) * [Environment Variables](03-04-environment-variables.md) * [Build Scripts](03-05-build-scripts.md) * [Publishing on crates.io](03-06-crates-io.md) - * [Package ID specs](03-07-pkgid-spec.md) + * [Package ID Specifications](03-07-pkgid-spec.md) * [Source Replacement](03-08-source-replacement.md) * [External Tools](03-09-external-tools.md) - * [Policies](03-10-policies.md) + * [Crates.io Package Policies](03-10-policies.md) [FAQ](faq.md) diff --git a/src/doc/book/src/cargo-in-depth.md b/src/doc/book/src/cargo-in-depth.md index b367ccba3..e4a749fee 100644 --- a/src/doc/book/src/cargo-in-depth.md +++ b/src/doc/book/src/cargo-in-depth.md @@ -5,11 +5,11 @@ crate, you may be interested in more details in the following areas. * [Reading about all the possible ways of specifying dependencies](03-01-specifying-dependencies.html) * [Learning more details about what you can specify in your `Cargo.toml` manifest](03-02-manifest.html) -* [Configuration](03-03-config.html) -* [Environment Variables](03-04-environment-variables.html) -* [Build Scripts](03-05-build-scripts.html) +* [Learn how Cargo's Configuration system works](03-03-config.html) +* [Environment Variables that Cargo sets and reads](03-04-environment-variables.html) +* [Build Script Support](03-05-build-scripts.html) * [Publishing your crate on crates.io](03-06-crates-io.html) -* [Package ID specs](03-07-pkgid-spec.html) -* [Source Replacement](03-08-source-replacement.html) -* [External Tools](03-09-external-tools.html) -* [Policies](03-10-policies.html) +* [Package ID Specifications](03-07-pkgid-spec.html) +* [Learn how to replace one source with another](03-08-source-replacement.html) +* [Integration with external tools, like IDEs and other build systems](03-09-external-tools.html) +* [Crates.io Package Policies](03-10-policies.html) -- 2.30.2